Event Notification APIs 4.0

(0 reviews)

Event Notification APIs Examples

Event Notification APIs

Event Subscription Examples:

Post/event-subscriptions:

This API endpoint allows the TPP to ask an ASPSP to create a new event-subscription resource.

POST Event Subscription Request

POST /event-subscriptions HTTP/1.1

curl --location --request POST 'https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/event-subscriptions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 0001O3q8WekSBEJmnySbQp9wuKfO' \
--header 'x-jws-signature: eyJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTY2MjAyNTgzMCwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJjcml0IjpbImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaWF0IiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyJdLCJraWQiOiI2NVp3NnRVT0F1ejRDcTlLQTFycnFYd1VLN0EiLCJjdHkiOiJhcHBsaWNhdGlvblwvanNvbiIsInR5cCI6IkpPU0UiLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyI6IjAwMTU4MDAwMDBqZlE5YUFBRVwvallYTVlER3EwdVRaZWU1cGVacHp3UiIsImFsZyI6IlBTMjU2In0..hjlUayNUuFHzzDyR7kv3akW5_wrdXZMplsfkCwjT_MjxQtAxwU9lvtGonQLXfZ87DMcXOgSTIhDKyKqCMwO5oGDeOCnMraXfVrO8Z3efn0eu1WpJTgQWYeW_qh7YZ8QaJR0jcv4TDF90tLQ3zQnwZBmKM6i9vA5Nv65OSK4-7nLe-b7Fi5bx9CvM4ujH1mAO4g48VSGvOdoP6UFFx5gHqFCxkS3k0sEZIIIwNxtn591hrbuDoqGVBg5BeZ1vHuNZx0uFX4yUTbmdPVckOuRYGdsKHGxp9Mc7cacwcCal-PjHkwxvQnfwQWaSiLGq46qnf1M2hP6JYKqXxd7kbLus-A' \
--data-raw '{"Data":{"Version":"4.0"}}
Request: {"Data":{"Version":"4.0"}}

POST Event Subscription Response

HTTP/1.1 201 Created
{
    "Data": {
        "EventSubscriptionId": "c5fd8a91-b705-402d-9ffe-cec21614f812",
        "Version": "4.0",
        "EventTypes": [
            "UK.OBIE.Consent-Authorization-Revoked"
        ]
    },
    "Links": {
        "Self": "https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/event-subscriptions/c5fd8a91-b705-402d-9ffe-cec21614f812"
    },
    "Meta": {
        "TotalPages": 1
    }
}

GET /event-subscriptions

The API endpoint allows the TPP to ask an ASPSP to retrieve its event-subscription resource. The ASPSP retrieves the event-subscription resource and responds with the resource.
GET Event Subscription Request

The API endpoint allows the TPP to ask an ASPSP to retrieve its event-subscription resource. The ASPSP retrieves the event-subscription resource and responds with the resource.

GET Event Subscription Request

GET /event-subscriptions HTTP/1.1

curl --location --request GET 'https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/event-subscriptions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 000168vJC9p3pP2i6ZcT2RS1eIMz' \
--header 'x-jws-signature: eyJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTY0NzMzODg3MSwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJjcml0IjpbImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaWF0IiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyJdLCJraWQiOiI2NVp3NnRVT0F1ejRDcTlLQTFycnFYd1VLN0EiLCJjdHkiOiJhcHBsaWNhdGlvblwvanNvbiIsInR5cCI6IkpPU0UiLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyI6IkNOPTAwMTU4MDAwMDBqZlE5YUFBRSwgT0lELjIuNS40Ljk3PVBTREdCLUZDQS01MTI5NTYsIE89QmFuayBvZiBJcmVsYW5kIChVSykgUGxjLCBDPUdCIiwiYWxnIjoiUFMyNTYifQ..pyCNCotpOPRa1MZ2e1jcQV2e880gBdSC5508YnO6BpV3NNYHW3Zf88KnBpJg5644vtWSIP-0UtjtFkPq5-Md3_d3p139jW1YbrMDveLE0aSGJvmYHed8kMlqtGeBMjzfkgvzl5-VeUeWIluqXtSAy7S2xK6rqCeunNve_7yaSoOrRMr1ojfe2rZPdfWWwq_Ay5BO6_B7OBj3OW5HPanAJuCh_Hjuogk7VuMccfkVlN5WyKx1Z4UCixbDjfZz7ARrJj-ucCOQ8Pzsx1-2wTG-4k82yQIjmStqnaDWPawHzDACELuaqzVkzjf-x4JRCiKy1xiAh-jAQk98udpZu5cyvg' \
--data-raw '{"Data":{"Version":"4.0"}}'

GET Event Subscription Response

GET/1.1 200 OK
{
    "Data": {
        "EventSubscription": [
            {
                "EventSubscriptionId": "6d59297b-9142-401b-8cc7-6f1ab0292020",
                "CallbackUrl": "https://tpp.com/open-banking/v4.0/event-notifications",
                "Version": "4.0",
                "EventTypes": [
                    "UK.OBIE.Consent-Authorization-Revoked",
                    "UK.OBIE.Resource-Update"
                ]
            }
        ]
    },
    "Links": {
        "Self": "https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/event-subscriptions"
    },
    "Meta": {
        "TotalPages": 1
    }
}

DELETE /event-subscriptions/{EventSubscriptionId}

The API endpoint allows the TPP to ask an ASPSP to delete an event-subscription resource. The ASPSP deletes the event-subscription resource.

DELETE Event Subscription Request

DELETE /event-subscriptions HTTP/1.1

curl --location --request DELETE 'https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/event-subscriptions/6d59297b-9142-401b-8cc7-6f1ab0292020' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 000168vJC9p3pP2i6ZcT2RS1eIMz' \
--header 'x-jws-signature: eyJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTY0NzMzODg3MSwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJjcml0IjpbImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaWF0IiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyJdLCJraWQiOiI2NVp3NnRVT0F1ejRDcTlLQTFycnFYd1VLN0EiLCJjdHkiOiJhcHBsaWNhdGlvblwvanNvbiIsInR5cCI6IkpPU0UiLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyI6IkNOPTAwMTU4MDAwMDBqZlE5YUFBRSwgT0lELjIuNS40Ljk3PVBTREdCLUZDQS01MTI5NTYsIE89QmFuayBvZiBJcmVsYW5kIChVSykgUGxjLCBDPUdCIiwiYWxnIjoiUFMyNTYifQ..pyCNCotpOPRa1MZ2e1jcQV2e880gBdSC5508YnO6BpV3NNYHW3Zf88KnBpJg5644vtWSIP-0UtjtFkPq5-Md3_d3p139jW1YbrMDveLE0aSGJvmYHed8kMlqtGeBMjzfkgvzl5-VeUeWIluqXtSAy7S2xK6rqCeunNve_7yaSoOrRMr1ojfe2rZPdfWWwq_Ay5BO6_B7OBj3OW5HPanAJuCh_Hjuogk7VuMccfkVlN5WyKx1Z4UCixbDjfZz7ARrJj-ucCOQ8Pzsx1-2wTG-4k82yQIjmStqnaDWPawHzDACELuaqzVkzjf-x4JRCiKy1xiAh-jAQk98udpZu5cyvg' \
--data-raw '{"Data":{"Version":"4.0"}}'

DELETE Event Subscription Response

DELETE/1.1 204 No Content
-H ‘Content-type: application/octet-stream; charset=UTF-8’ \
-H x-fapi-interaction-id: a7ab0644-1f6b-4c36-8b1e-37894411afc4

Aggregated Polling Example:

POST /events

The endpoint allows a TPP to poll and acknowledge the events.

POST Events Request

POST /events HTTP/1.1

curl --location --request POST 'https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/events' \
--header 'x-fapi-financial-id: 0015800000jfQ9aAAE' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 0001O3q8WekSBEJmnySbQp9wuKfO' \
--data-raw
{
  "returnImmediately": true,
  "maxEvents":1,
  "ack": [ "2644f8cbc8294325ad103ddfc4a5b15d" ],
  "setErrs": {
    "1fd954d5fb964afb97deee232bb88d1f": {
      "err": "jwtIss",
      "description": "Issuer is invalid or could not be verified"
    }
  }
}

POST Events Response

POST /events HTTP/1.1

-H ‘Content-Type: application/json’\
-H ‘x-fapi-interaction-id: 52db9992-1782-453b-826b-51aa7890cb57
{
    "moreAvailable": false,
    "sets": {
        "b0e1649c-e163-4ec8-bf78-577db22d4e4d": "eyJraWQiOiJabkROc2MyVXhfeG1kZEpPaU1fZkQzLVlKMDQiLCJ0eXAiOiJKT1NFIiwiYWxnIjoiUFMyNTYifQ.eyJhdWQiOiJqWVhNWURHcTB1VFplZTVwZVpwendSIiwic3ViIjoiaHR0cHM6Ly9hcGktc2FuZGJveC5ib2ljbG91ZHRlc3QubmV0LzEvYXBpL29wZW4tYmFua2luZy92NC4wL2Npc3AvZnVuZHMtY29uZmlybWF0aW9uLWNvbnNlbnRzLzEzMGZmYzU5LTMxNjctNGRhYS04NjJlLWY4ZmM4ZjRmOTBlNiIsImlzcyI6Imh0dHBzOi8vYXBpLXNhbmRib3guYm9pY2xvdWR0ZXN0Lm5ldCIsInR4biI6ImExZGI0YjI0LThjOTYtNGIxOS1hNGVlLWRiNWE1YmZkNjBiZSIsInRvZSI6MTc4NTczODg2MCwiZXZlbnQiOnsidXJuOnVrOm9yZzpvcGVuYmFua2luZzpldmVudHM6Y29uc2VudC1hdXRob3JpemF0aW9uLXJldm9rZWQiOnsic3ViamVjdCI6eyJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3JpZCI6IjEzMGZmYzU5LTMxNjctNGRhYS04NjJlLWY4ZmM4ZjRmOTBlNiIsInN1YmplY3RfdHlwZSI6Imh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvcmlkX2h0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvcnR5IiwiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay9ybGsiOlt7ImxpbmsiOiJodHRwczovL2FwaS1zYW5kYm94LmJvaWNsb3VkdGVzdC5uZXQvMS9hcGkvb3Blbi1iYW5raW5nL3Y0LjAvY2lzcC9mdW5kcy1jb25maXJtYXRpb24tY29uc2VudHMvMTMwZmZjNTktMzE2Ny00ZGFhLTg2MmUtZjhmYzhmNGY5MGU2IiwidmVyc2lvbiI6InY0LjAifV0sImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvcnR5IjoiZnVuZHMtY29uZmlybWF0aW9uLWNvbnNlbnRzIn19fSwiaWF0IjoxNzg1NzM4ODYwLCJqdGkiOiJiMGUxNjQ5Yy1lMTYzLTRlYzgtYmY3OC01NzdkYjIyZDRlNGQifQ.jfUD26BKW5N7oEayS1fHyH3xDj5YuizwJIMuCefUiOqoj58Yi7LUpkLNZg8WRWEdbZp9LP-Py7C9css82yG0HrGm5OglaG_J2lXvMChhKjFZeD7-kzoi75gbfcQyA0zQg4lJDuFI1Z3PhG0ZlZUPHjf_zAuQItM-BXiqxFAuBZIhBdBoLOpVFxFd4p01FlpHe5ftF6bO0hzZOSxuqa4gEdDwGq015oh0mrqTw4f_tnxsmLrlo4zMGh3cYb2GpAs62s1EAIl59SyasHy6ndhK6wKN85b_TTXXguvBMczkY1Q_8_CR0MedWO6B7UOP_-Crui6puAb1Bz3eNLE3kmCfHA"
    }
}

PUT /event-subscriptions/{EventSubscriptionId}

The API endpoint allows the TPP to ask an ASPSP to update an event-subscription resource. The ASPSP updates the event-subscription resource.

PUT Event Subscription Request

PUT /event-subscriptions HTTP/1.1

curl --location --request PUT 'https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/event-subscriptions/c5fd8a91-b705-402d-9ffe-cec21614f812' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 0001O3q8WekSBEJmnySbQp9wuKfO' \
--header 'x-jws-signature: eyJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTY2MjAyNTgzMCwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJjcml0IjpbImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaWF0IiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyJdLCJraWQiOiI2NVp3NnRVT0F1ejRDcTlLQTFycnFYd1VLN0EiLCJjdHkiOiJhcHBsaWNhdGlvblwvanNvbiIsInR5cCI6IkpPU0UiLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyI6IjAwMTU4MDAwMDBqZlE5YUFBRVwvallYTVlER3EwdVRaZWU1cGVacHp3UiIsImFsZyI6IlBTMjU2In0..hjlUayNUuFHzzDyR7kv3akW5_wrdXZMplsfkCwjT_MjxQtAxwU9lvtGonQLXfZ87DMcXOgSTIhDKyKqCMwO5oGDeOCnMraXfVrO8Z3efn0eu1WpJTgQWYeW_qh7YZ8QaJR0jcv4TDF90tLQ3zQnwZBmKM6i9vA5Nv65OSK4-7nLe-b7Fi5bx9CvM4ujH1mAO4g48VSGvOdoP6UFFx5gHqFCxkS3k0sEZIIIwNxtn591hrbuDoqGVBg5BeZ1vHuNZx0uFX4yUTbmdPVckOuRYGdsKHGxp9Mc7cacwcCal-PjHkwxvQnfwQWaSiLGq46qnf1M2hP6JYKqXxd7kbLus-A' \
--header 'x-cma-version: 4.0' \
--data-raw '{
    "Data": {
        "EventSubscriptionId": "c5fd8a91-b705-402d-9ffe-cec21614f812",
        "Version": "4.0",
        "EventTypes": [
            "UK.OBIE.Resource-Update"
        ],
        "CallbackUrl": "https://tpp.com/open-banking/v4.0/event-notifications"
    }
}'

PUT Event Subscription Response

PUT/1.1 200 OK

{
    "Data": {
        "EventSubscriptionId": "c5fd8a91-b705-402d-9ffe-cec21614f812",
        "CallbackUrl": "https://tpp.com/open-banking/v4.0/event-notifications",
        "Version": "4.0",
        "EventTypes": [
            "UK.OBIE.Resource-Update"
        ]
    },
    "Links": {
        "Self": "https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/event-subscriptions/c5fd8a91-b705-402d-9ffe-cec21614f812"
    },
    "Meta": {
        "TotalPages": 1
    }
}

Event Notification APIs Examples for SEPA Instant Payment

Event Subscription Examples:

Post/event-subscriptions:

This API endpoint allows the TPP to ask an ASPSP to create a new event-subscription resource.

POST Event Subscription Request

POST /event-subscriptions HTTP/1.1

curl -X POST \
https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/event-subscriptions \
-H ‘Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA’\
-H ‘x-jws-signature: eyJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTY0NzI0Mjkw
OCwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJjc
ml0IjpbImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaWF0IiwiaHR0cDpcL1wvb3BlbmJhbmtpbm
cub3JnLnVrXC90YW4iLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyJdLCJraWQiOiI2NVp
3NnRVT0F1ejRDcTlLQTFycnFYd1VLN0EiLCJjdHkiOiJhcHBsaWNhdGlvblwvanNvbiIsInR5cCI6IkpP
U0UiLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyI6IkNOPTAwMTU4MDAwMDBqZlE5YUFBR
SwgT0lELjIuNS40Ljk3PVBTREdCLUZDQS01MTI5NTYsIE89QmFuayBvZiBJcmVsYW5kIChVSykgUGxjLC
BDPUdCIiwiYWxnIjoiUFMyNTYifQ..qJIi8AGgtZuCpSZU-W8YTInfAIWrxSN5Ilf00jnzgi_NURn2wEr
jJR-crY0sz-f-nLjWOBAbpvCbSskdxDu_9RM_z-097HrF9grYElSG-RKfAqpGQ_yQseFYgtykE40yvFBG
JItDTlMPjZtEyX0eBrrHphjWtY2OZ9-HylSigy3tTTdIKO5VU5agwHjXccUAg_xPn7XYB-8a0vcrOP0Za
cuHbdlmUh-fwJCyR7CDOb71W2B-w5pyT0_QGF6PcjESELOlk0vPxf51fSU3r7efeH7Q5tqddv3DxskIn1
yF9PxuYcU2uzX3N9IdQE43GwfY7i5xmpM2rXG-zVnoqB8Hzg’\
-H ‘Content-Type: application/json;charset=utf-8
’ \

-d ‘{
  "Data": {
  "CallbackUrl" : "https://tpp.com/open-banking/v4.0/event-notifications",
  "Version": ”v4.0”,
  “EventsTypes : [
                      "UK.OBIE.Resource-Update",
   ]
  }

POST Event Subscription Response

HTTP/1.1 201 Created

-H ‘x-jws-signature: eyJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTY0NzI0MjkwO
CwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJjcml
0IjpbImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaWF0IiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub
3JnLnVrXC90YW4iLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyJdLCJraWQiOiI2NVp3NnR
VT0F1ejRDcTlLQTFycnFYd1VLN0EiLCJjdHkiOiJhcHBsaWNhdGlvblwvanNvbiIsInR5cCI6IkpPU0UiL
CJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyI6IkNOPTAwMTU4MDAwMDBqZlE5YUFBRSwgT0l
ELjIuNS40Ljk3PVBTREdCLUZDQS01MTI5NTYsIE89QmFuayBvZiBJcmVsYW5kIChVSykgUGxjLCBDPUdCI
iwiYWxnIjoiUFMyNTYifQ..qJIi8AGgtZuCpSZU-W8YTInfAIWrxSN5Ilf00jnzgi_NURn2wErjJR-crY0
sz-f-nLjWOBAbpvCbSskdxDu_9RM_z-097HrF9grYElSG-RKfAqpGQ_yQseFYgtykE40yvFBGJItDTlMPj
ZtEyX0eBrrHphjWtY2OZ9-HylSigy3tTTdIKO5VU5agwHjXccUAg_xPn7XYB-8a0vcrOP0ZacuHbdlmUh-
fwJCyR7CDOb71W2B-w5pyT0_QGF6PcjESELOlk0vPxf51fSU3r7efeH7Q5tqddv3DxskIn1yF9PxuYcU2u
zX3N9IdQE43GwfY7i5xmpM2rXG-zVnoqB8Hzg’\
-H ‘x-fapi-interaction-id: 86ebcd82-8e38-4f2d-a79c-965b41d15865’\
-H ‘Content-Type: application/json;charset=utf-8’\

-d ‘{
 "Data": {
        "EventSubscriptionId": "2319b838-4fbb-4978-9fc2-ea7e2dd7f45e",
        "CallbackUrl" : "https://tpp.com/open-banking/v4.0/event-notifications",
        "Version": "3.1",
        "EventTypes": [
                          "UK.OBIE.Resource-Update",
        ]
    },
    "Links": {
        "Self": "https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/event-subscriptions/2319b838-4fbb-4978-9fc2-ea7e2dd7f45e"
    },
    "Meta": {
        "TotalPages": 1
    }
}’

GET /event-subscriptions

The API endpoint allows the TPP to ask an ASPSP to retrieve its event-subscription resource. The ASPSP retrieves the event-subscription resource and responds with the resource.

GET Event Subscription Request

GET /event-subscriptions HTTP/1.1

curl -X POST \
https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/event-subscriptions \
-H ‘Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA’\
-H ‘Content-Type: application/json’\
-H ‘x-jws-signature: eyJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTY0NzI0Mjk
wOCwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJ
jcml0IjpbImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaWF0IiwiaHR0cDpcL1wvb3BlbmJhbmt
pbmcub3JnLnVrXC90YW4iLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyJdLCJraWQiOiI
2NVp3NnRVT0F1ejRDcTlLQTFycnFYd1VLN0EiLCJjdHkiOiJhcHBsaWNhdGlvblwvanNvbiIsInR5cCI
6IkpPU0UiLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyI6IkNOPTAwMTU4MDAwMDBqZlE
5YUFBRSwgT0lELjIuNS40Ljk3PVBTREdCLUZDQS01MTI5NTYsIE89QmFuayBvZiBJcmVsYW5kIChVSyk
gUGxjLCBDPUdCIiwiYWxnIjoiUFMyNTYifQ..qJIi8AGgtZuCpSZU-W8YTInfAIWrxSN5Ilf00jnzgi_
NURn2wErjJR-crY0sz-f-nLjWOBAbpvCbSskdxDu_9RM_z-097HrF9grYElSG-RKfAqpGQ_yQseFYgty
kE40yvFBGJItDTlMPjZtEyX0eBrrHphjWtY2OZ9-HylSigy3tTTdIKO5VU5agwHjXccUAg_xPn7XYB-8
a0vcrOP0ZacuHbdlmUh-fwJCyR7CDOb71W2B-w5pyT0_QGF6PcjESELOlk0vPxf51fSU3r7efeH7Q5tq
ddv3DxskIn1yF9PxuYcU2uzX3N9IdQE43GwfY7i5xmpM2rXG-zVnoqB8Hzg’\

GET Event Subscription Response

GET/1.1 200 OK

-H ‘x-jws-signature: eyJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTY0NzI0Mjkw
OCwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJjc
ml0IjpbImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaWF0IiwiaHR0cDpcL1wvb3BlbmJhbmtpbm
cub3JnLnVrXC90YW4iLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyJdLCJraWQiOiI2NVp
3NnRVT0F1ejRDcTlLQTFycnFYd1VLN0EiLCJjdHkiOiJhcHBsaWNhdGlvblwvanNvbiIsInR5cCI6IkpP
U0UiLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyI6IkNOPTAwMTU4MDAwMDBqZlE5YUFBR
SwgT0lELjIuNS40Ljk3PVBTREdCLUZDQS01MTI5NTYsIE89QmFuayBvZiBJcmVsYW5kIChVSykgUGxjLC
BDPUdCIiwiYWxnIjoiUFMyNTYifQ..qJIi8AGgtZuCpSZU-W8YTInfAIWrxSN5Ilf00jnzgi_NURn2wEr
jJR-crY0sz-f-nLjWOBAbpvCbSskdxDu_9RM_z-097HrF9grYElSG-RKfAqpGQ_yQseFYgtykE40yvFBG
JItDTlMPjZtEyX0eBrrHphjWtY2OZ9-HylSigy3tTTdIKO5VU5agwHjXccUAg_xPn7XYB-8a0vcrOP0Za
cuHbdlmUh-fwJCyR7CDOb71W2B-w5pyT0_QGF6PcjESELOlk0vPxf51fSU3r7efeH7Q5tqddv3DxskIn1
yF9PxuYcU2uzX3N9IdQE43GwfY7i5xmpM2rXG-zVnoqB8Hzg’ \
-H ‘x-fapi-interaction-id: 86ebcd82-8e38-4f2d-a79c-965b41d15865’ \
-H ‘Content-Type: application/json’ \

-d ‘{

"Data": {
        "EventSubscription": [
            {
                "EventSubscriptionId": "2319b838-4fbb-4978-9fc2-ea7e2dd7f45e",
                 "CallbackUrl" : "https://tpp.com/open-banking/v4.0/event-notifications",
                "Version": ”v4.0”,
                "EventTypes": [
                                          "UK.OBIE.Resource-Update",
                ]
            }
        ]
    },
    "Links": {
        "Self": "https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/event-subscriptions"
    },
    "Meta": {
        "TotalPages": 1
    }
}’

DELETE /event-subscriptions/{EventSubscriptionId}

The API endpoint allows the TPP to ask an ASPSP to delete an event-subscription resource. The
ASPSP deletes the event-subscription resource.

DELETE Event Subscription Request

DELETE /event-subscriptions HTTP/1.1

curl -X POST \
https://api.boi-sandbox.apiboitest.com/1/api/open-banking/ v4.0/event-subscriptions \
-H ‘Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA’\

DELETE Event Subscription Response

DELETE/1.1 204 No Content

-H ‘Content-type: application/octet-stream; charset=UTF-8’ \
-H x-fapi-interaction-id: 495e23b3-2e69-4704-985b-7fd9738df2fd

Real Time Event Notification Example:

POST /event-notifications

The API endpoint allows the ASPSP to send an event-notification resource to a TPP.

POST Events Notification Request
{
  "iss": "https://examplebank.com/",
  "iat": 1516239022,
  "jti": "b460a07c-4962-43d1-85ee-9dc10fbb8f6c",
  "sub": "https://examplebank.com/api/open-banking/ v4.0/aisp/account-access-consents/aac-1234-007",
  "aud": "7umx5nTR33811QyQfi",
  "events": {
    "urn:uk:org:openbanking:events:resource-update": {
      "subject": {
        "subject_type": "http://openbanking.org.uk/rid_http://openbanking.org.uk/rty",
        "http://openbanking.org.uk/rid": "aac-1234-007",
        "http://openbanking.org.uk/rty": "account-access-consent",
        "http://openbanking.org.uk/rlk": [{
            "version": "v4.0",
            "link": "https://examplebank.com/api/open-banking/v4.0/aisp/account-access-consents/aac-1234-007"
          }
        ]
      }
    }
  },
  "txn": "dfc51628-3479-4b81-ad60-210b43d02306",
  "toe": 1516239022
}

POST Events Notification Response

HTTP/1.1 202 Accepted

x-fapi-interaction-id: 14ba1762-a316-4a87-8d6e-5bfbefaf01d7

Reviews

Event Notification API doesn't have any reviews yet